/**
 * @(#) .java
 * Copyright (C) 2008 T.S.Yo tingshuo.yo@gmail.com
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 */
package entities;

/**
 * @author tsyo
 * Entity is the fundamental elements used in this software.  
 */
public class Entity {
	// Entity attributes
	private String name;
	private String type;
	private String description;
	
	/**
	 * Set the name of the entity.
	 * @param name
	 */
	public void setName(String name) {
		this.name = name;
	}
	
	/**
	 * Set the type of the entity.
	 * @param type
	 */
	public void setType(String type) {
		this.type = type;
	}

	/**
	 * Set the description of the entity.
	 * @param description
	 */
	public void setDescription(String description) {
		this.description = description;
	}
	
	/**
	 * Return the name of the entity.
	 * @return the name of the entity as a string.
	 */
	public String getName() {
		return (this.name);
	}
	
	/**
	 * Return the type of the entity.
	 * @return the type of the entity as a string.
	 */
	public String getType() {
		return (this.type);
	}
	
	/**
	 * Return the description of the entity.
	 * @return the description of the entity as a string.
	 */
	public String getDescription() {
		return (this.description);
	}
	
	/**
	 * Return the summary of this entity
	 */
	public String getSummary(){
		return( "Name: " + this.name + "\n" +
				"Type: " + this.type + "\n" +
				"Description:\n" + this.description + "\n");
	}
}
